# Data Dictionary / Dicionário de Dados  
## VigiMed Dataset (2018–2025)

---

## 📘 Project Description / Descrição do Projeto

**[EN]**  
This dataset contains Individual Case Safety Reports (ICSRs) from VigiMed, Brazil's national pharmacovigilance system. The data is organized in a Star Schema to facilitate drug safety analysis and data mining.

**[PT]**  
Este dataset contém notificações de eventos adversos (ICSRs) do VigiMed, o sistema nacional de farmacovigilância do Brasil. Os dados estão organizados em um Esquema Estrela (Star Schema) para facilitar análises de segurança de medicamentos e mineração de dados.

---

## ⚙️ Technical Specifications / Especificações Técnicas

- **Format / Formato:** Parquet  
- **Main Key / Chave Principal:** `IDENTIFICACAO_NOTIFICACAO`  
- **Automation / Automação:** GitHub Actions (ETL pipeline)  
- **Tools / Ferramentas:** Python, SQL, DuckDB  

---

## 📊 1. Fact Tables / Tabelas de Fatos

### 🔹 `fat_reacoes` (Adverse Reactions / Reações)

| Column / Coluna | Type / Tipo | Description (EN) | Descrição (PT) |
|----------------|------------|------------------|----------------|
| IDENTIFICACAO_NOTIFICACAO | string | Unique report identifier | Identificador único da notificação |
| DATAINICIOHORA | datetime | Reaction start date | Data de início da reação |
| REACAO_CHAVE | String | MedDRA LLT Foreign Key | Chave estrangeira MedDRA LLT |
| GRAVE_CHAVE | integer | Seriousness indicator (1=Yes) | Indicador de gravidade (1=Sim) |
| GRAVIDADE_HOSPITALIZACAO | boolean | Required hospitalization | Exigiu hospitalização |
| GRAVIDADERESULTADOOBITO | boolean | Resulted in death | Resultou em óbito |

---

### 🔹 `fat_medicamentos` (Medications / Medicamentos)

| Column / Coluna | Type / Tipo | Description (EN) | Descrição (PT) |
|----------------|------------|------------------|----------------|
| IDENTIFICACAO_NOTIFICACAO | string | Unique report identifier | Identificador único da notificação |
| NOMEMEDICAMENTOWHODRUG | string | Standardized name (WHO) | Nome padronizado (WHO Drug) |
| PRINCIPIOSATIVOSWHODRUG | string | Active substance | Substância ativa |
| ATCCODELEVEL_4 | string | ATC Code Level 4 | Código ATC Nível 4 |
| DOSE_VALOR | float | Reported dose value | Valor da dose relatada |

---

## 🧩 2. Dimension Tables / Tabelas de Dimensões

### 🔹 `dim_notificacoes` (Demographics / Demografia)

| Column / Coluna | Type / Tipo | Description (EN) | Descrição (PT) |
|----------------|------------|------------------|----------------|
| UF_VALOR | string | Brazilian State | Estado brasileiro (UF) |
| IDADEMOMENTOREACAO_VALOR | float | Patient age at event | Idade do paciente no evento |
| SEXO_VALOR | string | Patient sex | Sexo do paciente |
| NOTIFICADOR_VALOR | string | Notifier profile | Perfil do notificador |

---

### 🔹 `dim_atc` (ATC Classification / Classificação ATC)

| Column / Coluna | Type / Tipo | Description (EN) | Descrição (PT) |
|----------------|------------|------------------|----------------|
| ATCCODELEVEL1LEVEL_NAME | string | Anatomical group | Grupo anatômico principal |
| DDD_VALUE | float | Defined Daily Dose | Dose Diária Definida (WHO) |

---

### 🔹 `dim_soc_llt` (MedDRA Hierarchy / Hierarquia MedDRA)

| Column / Coluna | Type / Tipo | Description (EN) | Descrição (PT) |
|----------------|------------|------------------|----------------|
| SOC_NAME | string | System Organ Class | Classe de Órgão de Sistema |
| PT_NAME | string | Preferred Term | Termo Preferencial |

---

## 🔒 Data Integrity / Integridade de Dados

**[EN]**  
The dataset includes HASH columns (`HASH_BRONZE`, `HASH_SILVER`, `HASH_GOLD`) to ensure traceability and integrity throughout the ETL process.

**[PT]**  
O dataset inclui colunas de HASH (`HASH_BRONZE`, `HASH_SILVER`, `HASH_GOLD`) para garantir a rastreabilidade e integridade durante todo o processo de ETL.

---

## 💻 Source Code and Automation / Código Fonte e Automação

**[EN]**  
The code for data extraction, processing, and automation via GitHub Actions is available at:  
https://github.com/mlab-inf-ufrgs/vigimed  

**[PT]**  
O código para extração, processamento e automação via GitHub Actions está disponível em:  
https://github.com/mlab-inf-ufrgs/vigimed  

---
